|
2 | 2 | ## this is a repository for DatCode's portal to the world. (the website.) |
3 | 3 |
|
4 | 4 | Anyone from the community can contribute! Make sure your changes are well documented, and make sure you follow the guidelines as to keep the code clean and readable. |
5 | | - |
6 | | -### version 1.0 |
7 | | -This is the initial version. Just a one page site, giving insight to the three pillars of DatCode: |
8 | | -* sharing |
9 | | -* collaboration |
10 | | -* conversation |
11 | | - |
12 | | -...and a contact section at the bottom. |
13 | 5 |
|
| 6 | +### coding guidelines |
| 7 | +A more thorough set of coding guidelines soon come. For starters: |
| 8 | +* keep it neat and readable. That means use your tabs. |
| 9 | +* use nouns so it's easier to read and we can follow what it is you're doing. |
| 10 | +* use comments liberally. Too many comments are never a bad thing. |
| 11 | +* if you'd like, mark your work with your name/tag, so other contributors can refer back if they have questions. |
| 12 | + |
14 | 13 | ### new features |
15 | 14 | We'll keep a running list of features we'd like to add to the site. |
16 | 15 | - [ ] calendar (to be used for events) |
17 | 16 | - [ ] newsletter sign-up (tentative; should we decide to make one) |
18 | 17 | - [ ] ticker for number of Slack members, #DatCode mentions on Twitter and Facebook |
19 | 18 |
|
| 19 | +Components (as of v1.0): |
| 20 | +* [Bootstrap](http://www.getbootstrap.com) |
| 21 | +* [FontAwesome](http://www.fontawesome.io) for the icons |
| 22 | +* [JQuery](http://www.jquery.org) (Bootstrap dependency for navbar collapse) |
| 23 | +* [Less](http://www.lesscss.org) because using LESS for CSS is so much better |
| 24 | +* script.js has a script for the in-page links (scrolling to the section on the page) |
20 | 25 |
|
21 | | -### coding guidelines |
22 | | -A more thorough set of coding guidelines soon come. For starters: |
23 | | -* keep it neat and readable. That means use your tabs. |
24 | | -* use nouns so it's easier to read and we can follow what it is you're doing. |
25 | | -* use comments liberally. Too many comments are never a bad thing. |
26 | | -* if you'd like, mark your work with your name/tag, so other contributors can refer back if they have questions. |
| 26 | +### version 1.0 |
| 27 | +This is the initial version. Just a one page site, divied up into a "Why?", "What?" and "How?" |
| 28 | + |
| 29 | +The "Why?" - why are we doing this? |
| 30 | +The "What?" - okay so what are y'all doing? |
| 31 | +The "How?" - aite I'm interested, how do I join? |
| 32 | + |
| 33 | +Pretty simple stuff. We can expand as it gets larger and parts start moving. |
27 | 34 |
|
0 commit comments