Skip to content

Commit 6b65649

Browse files
authored
Some updates to README (#158)
* Remove obsolete website reference @steffennissen's domain leenissen.dk seems to have been taken over by some Thai domain squatter in 2024 (see https://punktum.dk/domaene/ikke-tilg%C3%A6ngelig?domain=leenissen.dk) and now contains only some sloppy and shallow texts about FANN. * Add section about precompiled packages * reference repology package status * detail Debian package names and installation command * Fix whitespace & use consistent command markup
1 parent 3907e1b commit 6b65649

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
**Fast Artificial Neural Network (FANN) Library** is a free open source neural network library, which implements multilayer artificial neural networks in C with support for both fully connected and sparsely connected networks.
55

6-
Cross-platform execution in both fixed and floating point are supported. It includes a framework for easy handling of training data sets. It is easy to use, versatile, well documented, and fast.
6+
Cross-platform execution in both fixed and floating point are supported. It includes a framework for easy handling of training data sets. It is easy to use, versatile, well documented, and fast.
77

8-
Bindings to more than 15 programming languages are available.
8+
Bindings to more than 15 programming languages are available.
99

10-
An easy to read introduction article and a reference manual accompanies the library with examples and recommendations on how to use the library.
10+
An easy to read introduction article and a reference manual accompanies the library with examples and recommendations on how to use the library.
1111

1212
Several graphical user interfaces are also available for the library.
1313

@@ -40,22 +40,32 @@ Several graphical user interfaces are also available for the library.
4040

4141
First you'll want to clone the repository:
4242

43-
`git clone https://github.com/libfann/fann.git`
43+
git clone https://github.com/libfann/fann.git
4444

4545
Once that's finished, navigate to the Root directory. In this case it would be ./fann:
4646

47-
`cd ./fann`
47+
cd ./fann
4848

4949
Then run CMake
5050

51-
`cmake .`
51+
cmake .
5252

5353
After that, you'll need to use elevated privileges to install the library:
5454

55-
`sudo make install`
55+
sudo make install
5656

5757
That's it! If everything went right, you should see a lot of text, and FANN should be installed!
5858

59+
#### From Distribution Packages
60+
61+
Many Linux distributions carry precompiled FANN packages in their binary repositories.
62+
63+
See Repology for further information: [![Packaging status](https://repology.org/badge/tiny-repos/fann.svg)](https://repology.org/project/fann/versions).
64+
65+
On Debian derived distributions install the package [libfann2](https://packages.debian.org/search?searchon=names&keywords=libfann2) and potentially [libfann-dev](https://packages.debian.org/search?searchon=names&keywords=libfann-dev) if you desire to develop for the library. Fx. by issuing the following command in a root terminal:
66+
67+
apt install libfann2 libfann-dev
68+
5969
### Building fann - Using vcpkg
6070

6171
You can download and install fann using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
@@ -67,9 +77,3 @@ You can download and install fann using the [vcpkg](https://github.com/Microsoft
6777
./vcpkg install fann
6878

6979
The fann port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
70-
71-
## To Learn More
72-
73-
To get started with FANN, go to the [FANN help site](http://leenissen.dk/fann/wp/help/), which will include links to all the available resources.
74-
75-
For more information about FANN, please refer to the [FANN website](http://leenissen.dk/fann/wp/)

0 commit comments

Comments
 (0)