Dekker1/Fourmi
Archived
1
0
Fork 0
Code

Updated the Objectives and linkage to the wiki

Browse Source
This commit is contained in:
Jip J. Dekker 2014-06-15 19:26:13 +02:00
parent a1859f2ec2
commit ee7f1ab739
1 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -23,21 +23,21 @@ documentation](http://doc.scrapy.org/en/latest/index.html).
### Installing ### Installing
If you're installing Fourmi, please take a look at our [installation guide](...) If you're installing Fourmi, please take a look at our installation guides
on our wiki. When you've installed the application, make sure to check our on our [wiki](https://github.com/jjdekker/Fourmi/wiki). When you've installed the application, make sure to check our
[usage guide](...). usage guide on the [Command Line Interface](https://github.com/jjdekker/Fourmi/wiki/CLI) and on the [Graphical User Interface](https://github.com/jjdekker/Fourmi/wiki/GUI).
### Using the Source ### Using the Source
To use the Fourmi source code multiple dependencies are required. Take a look at To use the Fourmi source code multiple dependencies are required. Take a look at
the [wiki page](...) on using the application source code for a step by step our [wiki pages](https://github.com/jjdekker/Fourmi/wiki) on using the application source code in our a step by step
installation guide. installation guide.
When developing for the Fourmi project keep in mind that code readability is a When developing for the Fourmi project keep in mind that code readability is a
must. To maintain the readability, code should be conform with the must. To maintain the readability, code should be conform with the
[PEP-8](http://legacy.python.org/dev/peps/pep-0008/) style guide for Python [PEP-8](http://legacy.python.org/dev/peps/pep-0008/) style guide for Python
code. More information about the different structures and principles of the code. More information about the different structures and principles of the
Fourmi application can be found on our [wiki](...). Fourmi application can be found on our [wiki](https://github.com/jjdekker/Fourmi/wiki).
### To Do ### To Do
@ -45,13 +45,9 @@ The Fourmi project has the following goals for the nearby future:
__Main goals:__ __Main goals:__
- Improve our documentation and guides. (Assignee: Dekker)
- Build an graphical user interface(GUI) as alternative for the command line - Build an graphical user interface(GUI) as alternative for the command line
interface(CLI). (Assignee: Harmen) interface(CLI). (Assignee: Harmen)
- Compiling the source into an windows executable. (Assignee: Bas) - Compiling the source into an windows executable. (Assignee: Bas)
- Create an configuration file to hold logins and API keys.
- Determine reliability of our data point.
- Create an module to gather data from NIST. (Assignee: Rob)
- Create an module to gather data from PubChem. (Assignee: Nout) - Create an module to gather data from PubChem. (Assignee: Nout)
__Side goals:__ __Side goals:__