Skip to content

Commit f0bf747

Browse files
authored
Merge pull request #574 from julianschacher/improve_readme
Make README more readable.
2 parents 65fa1dd + 3bdc9e5 commit f0bf747

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,32 @@
88

99
The Arcane Algorithm Archive is a collaborative effort to create a guide for all important algorithms in all languages.
1010
This goal is obviously too ambitious for a book of any size, but it is a great project to learn from and work on and will hopefully become an incredible resource for programmers in the future.
11-
The book can be found here: https://www.algorithm-archive.org/.
12-
The GitHub repository can be found here: https://github.com/algorithm-archivists/algorithm-archive.
13-
Most algorithms have been covered on the YouTube channel LeiosOS: https://www.youtube.com/user/LeiosOS
14-
and live coded on Twitch: https://www.twitch.tv/simuleios.
15-
If you would like to communicate more directly, please feel free to go to our discord: https://discord.gg/Pr2E9S6.
1611

12+
Here are some essential links:
13+
14+
- Book / website: <https://www.algorithm-archive.org/>
15+
- GitHub repository: <https://github.com/algorithm-archivists/algorithm-archive>
16+
- YouTube channel (LeiosOS): <https://www.youtube.com/user/LeiosOS>
17+
- Twitch livestream (simuleios): <https://www.twitch.tv/simuleios>
18+
- Discord server: <https://discord.gg/Pr2E9S6>
1719

1820
Note that this project is essentially a book about algorithms collaboratively written by an online community.
1921
Fortunately, there are a lot of algorithms out there, which means that there is a lot of content material available.
2022
Unfortunately, this means that we will probably never cover every algorithm ever created and instead need to focus on what the community sees as useful and necessary.
2123
That said, we'll still cover a few algorithms for fun that have very little, if any practical purpose.
2224

23-
If you would like to contribute, feel free to go to any chapter with code associated with it and implement that algorithm in your favorite language,
24-
and then submit the code via pull request, following the submission guidelines found in `contents/how_to_contribute/how_to_contribute.md` (or [here](contents/how_to_contribute/how_to_contribute.md) if you are reading this on GitBook).
25+
If you would like to contribute, feel free to go to any chapter with code associated with it and implement that algorithm in your favorite language, and then submit the code via pull request.
26+
You can find help and instructions regarding the contribution process in our [How to Contribute](https://github.com/algorithm-archivists/algorithm-archive/wiki/How-to-Contribute) wiki entry.
2527

2628
Hopefully, this project will grow and allow individuals to learn about and try their hand at implementing different algorithms for fun and (potentially) useful projects.
2729
If nothing else, it will be an enjoyable adventure for our community.
2830

2931
Thanks for reading and let me know if there's anything wrong or if you want to see something implemented in the future!
3032

31-
3233
----
3334

3435
## License
36+
3537
The code examples for this project are licensed under the MIT license (found in [LICENSE.md](https://github.com/algorithm-archivists/algorithm-archive/blob/master/LICENSE.md)).
3638
All text content is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/legalcode) with attribution specified at the end of every chapter.
3739
All graphics are licensed under the license stated at the end of every chapter.

0 commit comments

Comments
 (0)