search

Othernet-Project / librarian-core

GNU General Public License v3.0
1 stars 0 forks source link

Developer Docs #9

Closed dbinoj closed 8 years ago

dbinoj commented 8 years ago

Is there any developer documentation available? From skimming thru the source code, I find that this is a web project and you are using Bottle Framework. I also could not find any info here in github on the project's purpose in the outernet ecosystem. Is there some info else where that I've missed looking?

foxbunny commented 8 years ago

We currently don't have developer documentation. Librarian is web-based interface for Outernet receivers. It has recently been split into about a dozen odd packages that provide different functionality that was previously part of Librarian app. librarian-core is a low-level package that provides server management, task queue, ACL, and a few other pieces that all other components rely on.

dbinoj commented 8 years ago

A list of such sub packages and an one line description will give clarity to developers looking at outernet's code for the first time. Shall I create a list in this project's README file for a start?

foxbunny commented 8 years ago

We will publish documentation once we release the new software.

dbinoj commented 8 years ago

Oh. Okay. I thought maybe other volunteer devs could also contribute while the software is being built! Community can reduce the development time for outernet team by at least trying to fix issues. BTW, what you guys do is really great and thought could lend a hand :smile:

foxbunny commented 8 years ago

Sure, feel free to submit a pull request. You can see a list of packages that are part of a receiver build here. If you have any more questions, feel free to continue the discussion here or in the forums. Closing this issue for now.