Skip to content

Commit 5b98230

Browse files
committed
Update README for new site structure
1 parent a9f8348 commit 5b98230

File tree

1 file changed

+53
-51
lines changed

1 file changed

+53
-51
lines changed

README.md

Lines changed: 53 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,77 @@
1-
# Python Users Group Nepal Website [![Build Status](https://travis-ci.org/PythonNepal/pythonnepal.github.io.svg?branch=source)](https://travis-ci.org/PythonNepal/pythonnepal.github.io)
1+
# Python Users Group Nepal Website
22

3-
This repository is for the Python User Group Nepal's website. The site is built-up using [Pelican](http://github.com/getpelican/pelican), a static site generator, powered by Python. The site's theme is based on [Pure Pelican Theme](https://github.com/PurePelicanTheme/pure-single).
3+
This repository is for the Python User Group Nepal's website. The site is a modern, responsive static website built with HTML, CSS, and JavaScript.
44

5-
## Find us :
5+
## Find us:
66

77
* [Meetup.com](https://www.meetup.com/PythonNepal/)
88
* [Facebook](https://www.facebook.com/groups/pythonnepal/)
99

10-
## Setup for local development
10+
## Project Structure
1111

12-
> Please use the `source` branch for making changes. The changes are reflected automatically to master by travis build
13-
14-
* Fork repo
15-
16-
[Fork](https://github.com/PythonNepal/pythonnepal.github.io/fork) the repository to your account so that you have your copy of the website.
17-
18-
* Clone repository
19-
20-
$ git clone --recursive git@github.com:<your-username>/pythonnepal.github.io.git pynepal-website
21-
22-
This will clone the repository on to your system and clone the submodules inside it as well recursively. Additionally, the folder to which it will be cloned to is called `pynepal-website`.
12+
```
13+
├── index.html # Homepage
14+
├── css/
15+
│ └── style.css # Main stylesheet
16+
├── js/
17+
│ └── main.js # JavaScript functionality
18+
├── images/
19+
│ └── logo/ # Logo assets
20+
├── pages/
21+
│ ├── companies.html # Companies using Python in Nepal
22+
│ ├── developers.html # Python developers in Nepal
23+
│ ├── meetups.html # Meetup information
24+
│ ├── resources.html # Learning resources
25+
│ └── videos.html # Video content
26+
├── components/
27+
│ ├── header.html # Reusable header component
28+
│ └── footer.html # Reusable footer component
29+
└── static/ # PDF files and other static assets
30+
```
2331

24-
* Set up a virtual env in that folder and activate it
32+
## Setup for Local Development
2533

26-
$ cd <repo>
27-
$ virtualenv venv
28-
$ source venv/bin/activate
34+
1. **Clone the repository**
2935

30-
* Install the requirements using `pip` from inside the virtual environment
36+
```bash
37+
git clone git@github.com:<your-username>/pythonnepal.github.io.git pynepal-website
38+
cd pynepal-website
39+
```
3140

32-
(venv)$ pip install -r requirements.txt
41+
2. **Start a local server**
3342

34-
* Start the server
43+
Using Python:
44+
```bash
45+
python -m http.server 8000
46+
```
3547

36-
fab serve
48+
Or using any other static file server of your choice.
3749

38-
* Visit local site
50+
3. **Visit the local site**
3951

40-
Open up your web browser and point it to [http://localhost:8000](http://localhost:8000) to see the site running locally. Yay!
52+
Open your browser and go to [http://localhost:8000](http://localhost:8000)
4153

42-
## Blog Workflow
54+
## Contributing
4355

44-
If you're interested in writing a blog post for the website, you need to follow the given steps below:
56+
See [CONTRIBUTING.md](CONTRIBUTING.md)
4557

46-
- [Fork](https://github.com/PythonNepal/pythonnepal.github.io/fork) the repository
47-
- Write a blog post using Markdown in the `content` directory
48-
- Push the changes to a topic branch, like `an-example-article`, on *your* fork of the repository
49-
- Make a [pull request](https://help.github.com/articles/using-pull-requests/) against the `master` branch.
58+
### Adding Yourself as a Developer
5059

51-
## Deployment
52-
We use [Fabric](http://www.fabfile.org/) for automating the tasks and deployment. Type `fab --list` to see the available commands.
60+
If you're a Python developer from Nepal, you can add yourself to the [developers page](http://pythonnepal.org/pages/developers.html):
5361

54-
```
55-
Available commands:
56-
57-
build Build local version of site
58-
clean Remove generated files
59-
preview Build production version of site
60-
publish Push the generated html to master branch on GitHub.
61-
rebuild `clean` then `build`
62-
regenerate Automatically regenerate site upon file modification
63-
reserve `build`, then `serve`
64-
serve
65-
```
62+
1. Fork the repository
63+
2. Edit `pages/developers.html`
64+
3. Add your information following the existing format
65+
4. Send us a pull request
6666

67+
### General Contributions
6768

68-
## Contributing
69+
1. Fork the repository
70+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
71+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
72+
4. Push to the branch (`git push origin feature/amazing-feature`)
73+
5. Open a Pull Request against the `source` branch
6974

70-
See [CONTRIBUTING.md](CONTRIBUTING.md)
75+
## License
7176

72-
If you're a python developer from Nepal, you can add yourself to [website](http://pythonnepal.org/pages/developers.html). To do that,
73-
- Fork the repository.
74-
- Edit the file present at `content/pages/developers.md`. The format is [Markdown](https://guides.github.com/features/mastering-markdown/).
75-
- Send us a pull request.
77+
See [LICENSE](LICENSE)

0 commit comments

Comments
 (0)