mirror of
https://codeberg.org/andyscott/exercism.git
synced 2024-11-09 21:30:47 -05:00
73 lines
3.1 KiB
Markdown
73 lines
3.1 KiB
Markdown
|
# Help
|
||
|
|
|
||
|
|
## Running the tests
|
||
|
|
|
||
|
|
Get the first test compiling, linking and passing by following the [three rules of test-driven development][3-tdd-rules].
|
||
|
|
|
||
|
|
The included makefile can be used to create and run the tests using the `test` task.
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ make test
|
||
|
|
```
|
||
|
|
|
||
|
|
Create just the functions you need to satisfy any compiler errors and get the test to fail.
|
||
|
|
Then write just enough code to get the test to pass.
|
||
|
|
Once you've done that, move onto the next test.
|
||
|
|
|
||
|
|
As you progress through the tests, take the time to refactor your implementation for readability and expressiveness and then go on to the next test.
|
||
|
|
|
||
|
|
Try to use standard C99 facilities in preference to writing your own low-level algorithms or facilities by hand.
|
||
|
|
|
||
|
|
## Checking for memory leaks
|
||
|
|
|
||
|
|
The makefile comes also with a build that checks some common mistakes regarding memory leaks and out of bound access to arrays.
|
||
|
|
To run these checks, use the following at the command line:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ make memcheck
|
||
|
|
```
|
||
|
|
|
||
|
|
[3-tdd-rules]: https://blog.cleancoder.com/uncle-bob/2014/12/17/TheCyclesOfTDD.html
|
||
|
|
|
||
|
|
## Submitting your solution
|
||
|
|
|
||
|
|
You can submit your solution using the `exercism submit hamming.c hamming.h` command.
|
||
|
|
This command will upload your solution to the Exercism website and print the solution page's URL.
|
||
|
|
|
||
|
|
It's possible to submit an incomplete solution which allows you to:
|
||
|
|
|
||
|
|
- See how others have completed the exercise
|
||
|
|
- Request help from a mentor
|
||
|
|
|
||
|
|
## Need to get help?
|
||
|
|
|
||
|
|
If you'd like help solving the exercise, check the following pages:
|
||
|
|
|
||
|
|
- The [C track's documentation](https://exercism.org/docs/tracks/c)
|
||
|
|
- The [C track's programming category on the forum](https://forum.exercism.org/c/programming/c)
|
||
|
|
- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
|
||
|
|
- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
|
||
|
|
|
||
|
|
Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
|
||
|
|
|
||
|
|
Make sure you have read the [C track-specific documentation][c-track] on the Exercism site.
|
||
|
|
This covers the basic information on setting up the development environment expected by the exercises.
|
||
|
|
|
||
|
|
## Submitting Incomplete Solutions
|
||
|
|
|
||
|
|
If you are struggling with a particular exercise, it is possible to submit an incomplete solution so you can see how others have completed the exercise.
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
|
||
|
|
To get help if having trouble, you can use the following resources:
|
||
|
|
|
||
|
|
- [StackOverflow][] can be used to search for your problem and see if it has been answered already. You can also ask and answer questions.
|
||
|
|
- [CPPReference][] can be used to look up information on C concepts, operators, types, standard library functions and more.
|
||
|
|
- [TutorialsPoint][] has similar content as CPPReference in its C programming section.
|
||
|
|
- [The C Programming][K&R] book by K&R is the original source of the language and is still useful today.
|
||
|
|
|
||
|
|
[c-track]: https://exercism.org/docs/tracks/c
|
||
|
|
[stackoverflow]: http://stackoverflow.com/questions/tagged/c
|
||
|
|
[cppreference]: https://en.cppreference.com/w/c
|
||
|
|
[tutorialspoint]: https://www.tutorialspoint.com/cprogramming/
|
||
|
|
[K&R]: https://www.amazon.com/Programming-Language-2nd-Brian-Kernighan/dp/0131103628/
|