root
/
public
mirror of https://github.com/01-edu/public.git
14
27
Fork 0
Code Releases Wiki Activity
Browse Source

Creating a new readme for the instructions

pull/1047/head
miguel 3 years ago committed by Clément
parent
1d401d80e9
commit
6e46b60e5d
5 changed files with 69 additions and 24 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 40
      subjects/quad/README.md
  2. 3
      subjects/quad/audit/README.md
  3. 2
      subjects/quadchecker/audit/README.md
  4. 46
      subjects/raid-testing/README.md
  5. 2
      subjects/sudoku/audit/README.md

40
subjects/quad/README.md
unescape_control_characters View File

@ -1,8 +1,8 @@
## quadrangle ## quadrangle
## quadA ### quadA
### Instructions #### Instructions
Write a function `QuadA` that prints a **valid** rectangle with a given width of `x` and height of `y`. Write a function `QuadA` that prints a **valid** rectangle with a given width of `x` and height of `y`.
@ -10,7 +10,7 @@ The function must draw the rectangles as in the examples.
If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing. If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing.
### Expected function #### Expected function
```go ```go
func QuadA(x,y int) { func QuadA(x,y int) {
@ -18,7 +18,7 @@ func QuadA(x,y int) {
} }
``` ```
### Usage #### Usage
Here are possible programs to test your function : Here are possible programs to test your function :
@ -110,9 +110,9 @@ $
--- ---
## quadB ### quadB
### Instructions #### Instructions
Write a function `QuadB` that prints a **valid** rectangle of width `x` and of height `y`. Write a function `QuadB` that prints a **valid** rectangle of width `x` and of height `y`.
@ -121,7 +121,7 @@ The function must draw the rectangles as in the examples.
If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing. If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing.
### Expected function #### Expected function
```go ```go
func QuadB(x,y int) { func QuadB(x,y int) {
@ -129,7 +129,7 @@ func QuadB(x,y int) {
} }
``` ```
### Usage #### Usage
Here are possible programs to test your function : Here are possible programs to test your function :
@ -221,9 +221,9 @@ $
--- ---
## quadC ### quadC
### Instructions #### Instructions
Write a function `QuadC` that prints a **valid** rectangle of width `x` and of height `y`. Write a function `QuadC` that prints a **valid** rectangle of width `x` and of height `y`.
@ -231,7 +231,7 @@ The function must draw the rectangles as in the examples.
If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing. If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing.
### Expected function #### Expected function
```go ```go
func QuadC(x,y int) { func QuadC(x,y int) {
@ -239,7 +239,7 @@ func QuadC(x,y int) {
} }
``` ```
### Usage #### Usage
Here are possible programs to test your function : Here are possible programs to test your function :
@ -331,9 +331,9 @@ $
--- ---
## quadD ### quadD
### Instructions #### Instructions
Write a function `QuadD` that prints a **valid** rectangle of width `x` and of height `y`. Write a function `QuadD` that prints a **valid** rectangle of width `x` and of height `y`.
@ -341,7 +341,7 @@ The function must draw the rectangles as in the examples.
If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing. If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing.
### Expected function #### Expected function
```go ```go
func QuadD(x,y int) { func QuadD(x,y int) {
@ -349,7 +349,7 @@ func QuadD(x,y int) {
} }
``` ```
### Usage #### Usage
Here are possible programs to test your function : Here are possible programs to test your function :
@ -441,9 +441,9 @@ $
--- ---
## quadE ### quadE
### Instructions #### Instructions
Write a function `QuadE` that prints a **valid** rectangle of width `x` and of height `y`. Write a function `QuadE` that prints a **valid** rectangle of width `x` and of height `y`.
@ -452,7 +452,7 @@ The function must draw the rectangles as in the examples.
If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing. If `x` and `y` are positive numbers, the program should print the rectangles as seen in the examples, otherwise, the function should print nothing.
### Expected function #### Expected function
```go ```go
func QuadE(x,y int) { func QuadE(x,y int) {
@ -460,7 +460,7 @@ func QuadE(x,y int) {
} }
``` ```
### Usage #### Usage
Here are possible programs to test your function : Here are possible programs to test your function :

3
subjects/quad/audit/README.md
unescape_control_characters View File

@ -1,7 +1,6 @@
#### quadA #### quadA
***NOTE: If you are an admin and you want to test this project, follow the instructions [HERE](https://github.com/01-edu/go-tests)*** > ***NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](../../raid-testing/README.md) before you proceed to the questions.***
##### Try running the function with the arguments: `"x=5 and y=3"` ##### Try running the function with the arguments: `"x=5 and y=3"`

2
subjects/quadchecker/audit/README.md
unescape_control_characters View File

@ -1,6 +1,6 @@
#### Quadrangle Checker #### Quadrangle Checker
***NOTE: If you are an admin and you want to test this project, follow the instructions [HERE](https://github.com/01-edu/go-tests)*** > ***NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](../../raid-testing/README.md) before you proceed to the questions.***
##### Try running the program: `"./quadA 3 3 | ./quadchecker"` ##### Try running the program: `"./quadA 3 3 | ./quadchecker"`

46
subjects/raid-testing/README.md
unescape_control_characters View File

@ -0,0 +1,46 @@
## Testing Raids
### File structure:
In order to run any test you need to make sure you have a clone of the [go-tests](https://github.com/01-edu/go-tests) repository as well as a repository with the student solution inside.
To run the tests make sure the two repositories are right next to each other:
```sh
Desktop/
⌊ piscine-go
⌊ solution.go
⌊ go-tests
⌊ tests
⌊ quad_test
⌊ main.go
```
### Commands:
To test an exercise, run this command in the `go-tests` folder:
```
go run ./tests/quad_test/
// OR
cd tests/
go run ./quad_test/
```
If you run the test and you don't get any output, it means the solution has successfully passed the test, on the other side if it does return some output, the test is failed and you will get an error message.
### After running the tests:
After you run the tests, if the student or group solution passed, you can put true to all the mandatory questions but you still have to verify the bonus questions to check if any bonus was done.
However, you should check that every member of the group has done their share of the work.
You can pick a question randomly and ask each team member to run the test and explain the result for example.
### Warning:
You should be very careful with the testing.
- Make sure that you are running the right student solution.
- Make sure that the folders are in the right path and at the same level.
- Make sure the command `go run .tests/exercise_to_test/` is written right.

2
subjects/sudoku/audit/README.md
unescape_control_characters View File

@ -1,6 +1,6 @@
#### Sudoku #### Sudoku
***NOTE: If you are an admin and you want to test this project, follow the instructions [HERE](https://github.com/01-edu/go-tests)*** > ***NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](../../raid-testing/README.md) before you proceed to the questions.***
##### Try running the program with the arguments: `".96.4...1" "1...6...4" "5.481.39." "..795..43" ".3..8...." "4.5.23.18" ".1.63..59" ".59.7.83." "..359...7"` ##### Try running the program with the arguments: `".96.4...1" "1...6...4" "5.481.39." "..795..43" ".3..8...." "4.5.23.18" ".1.63..59" ".59.7.83." "..359...7"`

Write Preview
Loading…
Cancel
Save