161sh/CatgirlIntelligenceAgency
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Viktor 2023-04-02 14:08:17 +02:00 committed by GitHub
parent 716ab35b4e
commit 40b8c8c128
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -13,9 +13,19 @@ Follow the set-up instructions in [📁 run/](run/)!
This is also necessary for the tests to run. Save yourself time and frustration and start here.
## Contributing
## Project Structure
[CONTRIBUTING.md](CONTRIBUTING.md)
[📁 code/](code/) - The Source Code. See [📄 code/readme.md](code/readme.md) for a further breakdown of the structure and architecture.
[📁 run/](run/) - Scripts and files used to run the search engine locally
[📁 third-party/](third-party/) - Third party code
[📁 doc/](doc/) - Supplementary documentation
[📄 CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute
[📄 LICENSE.md](LICENSE.md) - License terms
## Supporting
@ -24,3 +34,8 @@ Consider [supporting this project](https://memex.marginalia.nu/projects/edge/sup
## Contact
You can email <kontakt@marginalia.nu> with any questions or feedback.
## License
The bulk of the project is available with AGPL 3.0, with exceptions. Some parts are co-licensed under MIT,
third party code may have different licenses. See the appropriate readme.md / license.md.