Skip to content

Commit dc7e6d3

Browse files
committed
update README, adding how to add project
1 parent a69dcaa commit dc7e6d3

File tree

1 file changed

+50
-13
lines changed

1 file changed

+50
-13
lines changed

README.md

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Send a pull request adding a new file `_chapters/<your-chapter-name>.md`, where
3232
separating words with underscore (e.g. `london_pyton_sprints`).
3333

3434
The content of the file has a header section with some fields (started and finished with
35-
---), and the main description of the chapter afterwards.
35+
---), and the main description of the chapter afterwards.
3636
We are using markdown files to store your data and they can contain either markdown tags for text formatting or pure html - it is up to you how to style your content.<br>
3737
The image that will represent your chapter should be in jpeg format. The size the content is optimized for is: 1920 x 600 px.
3838
Please name it <your_chapter_name_1920x600px.jpg>.
@@ -52,10 +52,10 @@ This is the format:
5252
- <second-sponsor-id-to-be-listed-in-your-page>
5353
- <feel-free-to-add-as-many-as-you-want>
5454
---
55-
55+
5656
Here you can add any information about your group. How it started, which are the goals,
5757
what people can expect from it.
58-
58+
5959
This is a good time to remind you, that no sort of discrimination (gender, religion,
6060
age, sexual orientation...) is tolerated in the Python sprints (or in the Python
6161
community in general). And as an organizer you must not allow any sort of harassment
@@ -110,13 +110,13 @@ The content of the file has a header section with some fields (started and finis
110110
project: <id-of-the-project-you-will-work-on>
111111
sponsor: <id-of-the-sponsor-for-the-event>
112112
---
113-
113+
114114
This space is the main description of the event, where you can provide further details.
115-
116-
Note that you don't need to add information about the project, as the description of the
115+
116+
Note that you don't need to add information about the project if it already exists in the `_projects` folder, as the description of the
117117
project, the logo, and the environment set up instructions should be rendered automatically
118-
after specifying the id of the project.
119-
118+
after specifying the id of the project. If the project has not been added yet, you will need to add it before calling it here. If the event is not related to a specific project, you can leave the `<id-of-the-project-you-will-work-on>` blank.
119+
120120
Also, by specifying the id of the sponsor, a box with its information will appear.
121121

122122
Example event setup
@@ -131,16 +131,16 @@ Example event setup
131131
sponsor: harvey_nash
132132
---
133133
The content of your event's description goes below ---.
134-
134+
135135
You may want to copy one of the last events in `_posts` to be used as reference.
136136

137137
How to add a sponsor
138138
--------------------
139-
If you need to add your local sponsor which is not already in the _sponsors folder you can do so easily.<br>
139+
If you need to add your local sponsor which is not already in the `_sponsors` folder you can do so easily.<br>
140140
To add a sponsor logo please copy it to the static/images/sponsors folder with a name matching the obj_id of your sponsor.
141-
We use png files for our sponsors. The maximum size is: 258px x 82px so please scale them down to match one of those dimensions.
141+
We use png files for our sponsors. The maximum size is: 258px x 82px so please scale them down to match one of those dimensions. The logo width is: 150px, if a logo having width smaller than that will be stretch to match the logo width.
142142

143-
Create an <name_of_your_sponsor>.md file using the format below:
143+
Create a <name_of_your_sponsor>.md file using the format below:
144144

145145
---
146146
obj_id: <unique_identifier_of_your_sponsor>
@@ -152,7 +152,7 @@ Create an <name_of_your_sponsor>.md file using the format below:
152152
lng: <float-number-with-longitude-for-the-marker-in-the-map>
153153
---
154154
Here you can place a short description of your sponsor's business etc.
155-
155+
156156
Example sponsor setup
157157
---------------------
158158
---
@@ -166,6 +166,43 @@ Example sponsor setup
166166
---
167167
QuantumBlack is an advanced analytics firm operating at the intersection of strategy, technology & design to improve performance outcomes for organisations. With roots in Formula One, we now work across sector with some of the world's leading organisations in advanced industries, healthcare and finance.
168168

169+
How to add a project
170+
--------------------
171+
If you the project that you are going to work on is not already in the `_projects` folder you can do add it easily.<br>
172+
To add a project logo please copy it to the static/images/projects folder.
173+
We use png files for projects.
174+
175+
Create a <name_of_your_project>.md file using the format below:
176+
177+
---
178+
obj_id: <unique_identifier_of_your_project>
179+
name: "name of your project"
180+
logo: <relative path to your project logo>
181+
website: <website link to your project>
182+
setup_html: |
183+
<p>
184+
<!-- (link to) instruction of how to setup in html format -->
185+
</p>
186+
---
187+
Here you can place a short description of your project.
188+
189+
Example project setup
190+
---------------------
191+
---
192+
obj_id: pandas
193+
name: "Pandas"
194+
logo: static/images/projects/pandas_logo_donation.png
195+
website: https://pandas.pydata.org/
196+
setup_html: |
197+
<p>
198+
Please follow the instruction in this link:
199+
<a href="https://python-sprints.github.io/pandas/guide/index.html">
200+
https://python-sprints.github.io/pandas/guide/index.html
201+
</a>
202+
</p>
203+
---
204+
Pandas is an open source, BSD-licensed library providing high-performance, easy-to-use data structures and data analysis tools for the Python programming language.
205+
169206

170207
How does Jekyll work?
171208
---------------------

0 commit comments

Comments
 (0)