Updated GSoC 2014 Ideas (markdown)
This commit is contained in:
parent
0a56ed1320
commit
2bfafa974e
|
@ -147,27 +147,19 @@ Nimrod's standard library currently has a [``fsmonitor``](http://build.nimrod-la
|
||||||
|
|
||||||
**Mentor:** dom96 ([@dom96](http://github.com/dom96))
|
**Mentor:** dom96 ([@dom96](http://github.com/dom96))
|
||||||
|
|
||||||
___
|
|
||||||
#### Add a cross-platform stat()-like procedure to the operating system module "os.nim"
|
|
||||||
**Desirable skills:** Knowledge of file system api's for Linux, MacOSX, or Microsoft Windows.
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
* Implement a procedure which uses native stat-like calls on Linux, Mac, Windows, and other operating systems to gather detailed information about specific file system objects. Allow the bypassing of symlinks
|
|
||||||
and hardlinks, where possible.
|
|
||||||
|
|
||||||
**Difficulty:** Easy
|
|
||||||
|
|
||||||
**Mentor:** dom96 ([@dom96](http://github.com/dom96))
|
|
||||||
|
|
||||||
___
|
___
|
||||||
#### Enhance and expand standard library documentation
|
#### Enhance and expand standard library documentation
|
||||||
**Desirable skills:** Basic writing and documentation skills, web design and infrastructure setup.
|
**Desirable skills:** Basic writing and documentation skills, web design and infrastructure setup.
|
||||||
|
|
||||||
**Description**:
|
**Description**:
|
||||||
|
The Nimrod documentation is generally good but it lacks helpful code examples. It is also using a rather old design which is not on par with some of the documentation of other software projects out there.
|
||||||
|
|
||||||
|
**Tasks:**
|
||||||
|
|
||||||
* Ensure that documentation exists for all public methods and modules.
|
* Ensure that documentation exists for all public methods and modules.
|
||||||
* Create and design new CSS and HTML layouts for the documentation, to better fit with the main website.
|
* Create and design new CSS and HTML layouts for the documentation, the design should put readability above eyecandy.
|
||||||
* Add search capabilities to the online documentation.
|
* Add search capabilities to the online documentation.
|
||||||
* Add code examples to all modules and to a procedures (where appropriate).
|
* Add code examples to all modules and to all procedures (where appropriate).
|
||||||
|
|
||||||
**Difficulty:** Medium
|
**Difficulty:** Medium
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue