Skip to content

Commit e5d08f2

Browse files
committed
setup
1 parent 429dfc8 commit e5d08f2

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,13 @@ While working on _Adagrams_, it may help to think of a physical metaphor for thi
1616

1717
In this version of _Adagrams_, we will only be working with the English alphabet.
1818

19-
![an image of a pile of letter tiles](assets/letter-tiles.jpeg)
19+
![an image of a pile of letter tiles](images/letter-tiles.jpeg)
2020

21-
22-
## Project Development
23-
24-
### Pair Programming
21+
## Pair Programming
2522

2623
Utilize good pair programming practices. Refer to articles from the [Agile Alliance](http://guide.agilealliance.org/guide/pairing.html), the [Agile Institute](http://powersoftwo.agileinstitute.com/2015/02/benefits-of-pair-programming-revisited.html), and the lesson in Learn titled Intro to Pair Programming from Approaching a Problem if you need a refresher for some best practices. Switch _driver_ and _navigator_ roles often. When there is uncertainty or confusion, step away from the keyboard and discuss, plan, and document on paper or whiteboard before continuing.
2724

28-
### One-Time Project Setup
25+
## One-Time Project Setup
2926

3027
Follow these directions once, a the beginning of your project:
3128

@@ -36,47 +33,45 @@ Follow these directions once, a the beginning of your project:
3633

3734
![Fork Button](images/fork.png)
3835

39-
1. In Github, add the other membe(s) of your team as collaborators to the repository. Do this by a The student who forked the respository should first choosing **Settings** from the top menu bar, then **Manage access** from the left navigation, and finally **Invite teams or people**.
36+
2. In Github, add the other membe(s) of your team as collaborators to the repository. Do this by a The student who forked the respository should first choosing **Settings** from the top menu bar, then **Manage access** from the left navigation, and finally **Invite teams or people**.
4037

4138
![Settings](images/settings.png)
39+
4240
![Manage access](images/manage-access.png)
41+
4342
![Invite teams or people](images/invite.png)
4443

4544
The member(s) who are invite will need to accept the invitation either by accepting an email invitation or accepting the invitation in Github.
4645

47-
48-
49-
50-
5146
*Each member of the pair should complete the following steps:*
5247

53-
2. Navigate to your projects folder named `projects`
48+
3. Navigate to your projects folder named `projects`
5449

5550
```bash
5651
$ cd ~/Developer/projects
5752
```
5853

59-
. "Clone" (download a copy of this project) into your projects folder. This command makes a new folder called `adagrams-py`, and then puts the project into this new folder. Make sure you are cloning from your copy of the project and not the class version (ada-cX).
54+
4. "Clone" (download a copy of this project) into your projects folder. This command makes a new folder called `adagrams-py`, and then puts the project into this new folder. Make sure you are cloning from your copy of the project and not the class version (ada-cX).
6055

6156
```bash
6257
$ git clone ...
6358
```
6459

6560
Use `ls` to confirm there's a new project folder
6661

67-
4. Move your location into this project folder
62+
5. Move your location into this project folder
6863

6964
```bash
7065
$ cd adagrams-py
7166
```
7267

73-
5. Create a virtual environment named `venv` for this project:
68+
6. Create a virtual environment named `venv` for this project:
7469

7570
```bash
7671
$ python3 -m venv venv
7772
```
7873

79-
6. Activate this environment:
74+
7. Activate this environment:
8075

8176
```bash
8277
$ source venv/bin/activate
@@ -96,22 +91,27 @@ $ pip install -r requirements.txt
9691

9792
Summary of one-time project setup:
9893

94+
One person:
95+
- [ ] Fork the project respository
96+
- [ ] Invite team members to the respository
97+
98+
All team members:
9999
- [ ] `cd` into your `projects` folder
100100
- [ ] Clone the project onto your machine
101-
- [ ] `cd` into the `viewing-party` folder
101+
- [ ] `cd` into the `adagrams-py` folder
102102
- [ ] Create the virtual environment `venv`
103103
- [ ] Activate the virtual environment `venv`
104104
- [ ] Install the dependencies with `pip`
105105

106-
### Workflow
106+
## Porject Development Workflow
107107

108108
1. When you want to begin work on this project, ensure that your virtual environment is activated:
109109

110110
```bash
111111
$ source venv/bin/activate
112112
```
113113

114-
1. Run the game and play test your current wave. Replace the word `wave` below with the wave number (ie, 1, 2, 3 or 4):
114+
2. Run the game and play test your current wave. Replace the word `wave` below with the wave number (ie, 1, 2, 3 or 4):
115115

116116
```bash
117117
# Must be in activated virtual environment
@@ -123,18 +123,18 @@ $ python main.py wave
123123
- Check the `tests` folder, and find the test file you want to run
124124
- In that test file, read through each test case
125125

126-
4. Run the tests for your specific wave
126+
2. Run the tests for your specific wave
127127

128128
```bash
129129
# Must be in activated virtual environment
130130
$ pytest tests/test_wave_01.py
131131
```
132132

133-
4. Use play-testing wth your partner to guide your development.
133+
3. Use play-testing wth your partner to guide your development.
134134

135-
5. Use tests to verify your functions after thoroughly play-testing.
135+
4. Use tests to verify your functions after thoroughly play-testing.
136136

137-
6. Use git to commit your work regularly! Commit between each wave.
137+
5. Use git to commit your work regularly! Commit between each wave.
138138

139139
```bash
140140
# Add your current work
File renamed without changes.

0 commit comments

Comments
 (0)