diff --git a/dockerfile.c_toolchain b/Dockerfiles/dockerfile.c_toolchain similarity index 72% rename from dockerfile.c_toolchain rename to Dockerfiles/dockerfile.c_toolchain index 60da070..331b0c9 100644 --- a/dockerfile.c_toolchain +++ b/Dockerfiles/dockerfile.c_toolchain @@ -1,5 +1,4 @@ FROM ubuntu:18.04 -RUN apt-get update && apt-get install -y vim gcc indent clang clang-format gdb binutils +RUN apt-get update && apt-get install -y vim gcc indent clang clang-format gdb binutils nasm xxd WORKDIR /dmzOS -COPY ./config/* /root ENTRYPOINT [ "bash" ] diff --git a/README.md b/README.md index 98b325b..a5d69d0 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,27 @@ Rules: * Please provide an adequate entry in the Wiki for each non-trivial code contribution. For additional information, please refer to the [Wiki](https://gitea.dmz.rs/sborovic/dmzOS/wiki). + +# Instructions for running the utilities + +## c_toolchain utility docker image + +This is the consistent C toolchain environment, containing all the tools needed to run and develop the project. + +Dockerfile: `dockerfile.c_toolchain` +Run the docker-compose command to get a `bash` shell that is bound to the `dmzOS` directory: +```docker +docker-compose run --rm c_toolchain +``` + +Any changes in the container `dmzOS` directory will be reflected in the local `dmzOS` directory. + +The image contains `indent` and `clang-format` as `C` code formatters. + +A .vimrc file is automatically part of the image, and it contains a rule to make vim run the following formatting command on buffer save: +```bash +indent -kr -ts4 % +``` +This is using the Kernighan and Ritchie code styling, as well as identations with 4 spaces. + +If you want to use your own `.vimrc`, please replace the existing `.vimrc` file inside the `config` directory with it. diff --git a/TOOLCHAIN.md b/TOOLCHAIN.md deleted file mode 100644 index 9970aaa..0000000 --- a/TOOLCHAIN.md +++ /dev/null @@ -1,18 +0,0 @@ -# Instruction on running utilities - -## c_toolchain utility docker image - -Dockerfile: `dockerfile.c_toolchain` -Run the docker-compose command to get a `bash` shell that is bound to the `dmzOS` directory: -```bash -docker-compose run --rm c_toolchain -``` - -Any changes in the container shell will be reflected in the local `dmzOS` directory. - -The image contains `ident` abd `clang-format` as `C` code formatters. A .vimrc file is automatically part of the image, and it contains a rule to make vim run the following formatting command on buffer save: -```bash -ident -kr -ts4 % -``` - -This is using the Kernighan and Ritchie code styling, as well as identations with 4 spaces. diff --git a/docker-compose.yml b/docker-compose.yml index 6caf9e9..26b2a89 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,10 +3,11 @@ version: '3.8' services: c_toolchain: build: - context: ./ + context: ./Dockerfiles dockerfile: dockerfile.c_toolchain container_name: c_toolchain tty: true stdin_open: true volumes: - ./dmzOS:/dmzOS + - ./config/.vimrc:/root/.vimrc