Skip to content

Commit

Permalink
fix readme + separate test-gcc and test-makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
jcdkiki committed Mar 14, 2024
1 parent ee4e891 commit c35c97c
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 27 deletions.
15 changes: 10 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@

default: help

EXAMPLES = $(wildcard examples/ex-*)
.PHONY: $(EXAMPLES)
GCC_EXAMPLES = $(wildcard examples/ex-*)
MAKE_EXAMPLES = $(wildcard examples/make/ex-*)
.PHONY: $(GCC_EXAMPLES) $(MAKE_EXAMPLES)

$(EXAMPLES):
$(GCC_EXAMPLES):
examples/test-gcc.sh $@

$(MAKE_EXAMPLES):
examples/test-makefile.sh $@

########
# HELP #
########
Expand All @@ -24,8 +28,9 @@ help:
@echo " build_rules"
@echo " clean"
@echo "=== TARGETS FOR RUNNING EXAMPLES ==="
@for x in $(EXAMPLES); do echo " $$x"; done;

@for x in $(GCC_EXAMPLES); do echo " $$x"; done;
@for x in $(MAKE_EXAMPLES); do echo " $$x"; done;

########
# DEPS #
########
Expand Down
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,10 @@

## Как собрать и установить?

В одну строку:
```
sudo ./install-deps.sh && ./build-oclint.sh && ./install-oclint.sh && mkdir build && cd build && cmake ../ && cmake --build . && sudo cmake --install . && cd ..
sudo make install
```

То же самое, только в человекочитаемом виде:
```bash
sudo ./install-deps.sh
Больше информации по сборке в [Wiki (Сборка и установка)](https://github.com/moevm/oclint_extensions/wiki/Сборка-и-установка)

./build-oclint.sh
./install-oclint.sh

mkdir build
cd build
cmake ../
cmake --build .
sudo cmake --install .
```

Больше информации в [Wiki](https://github.com/moevm/oclint_extensions/wiki/Сборка-и-установка)

Папка `examples` содержит примеры "проектов" с плохим кодом, а также скрипты `test-gcc.sh` и
`test-makefile.sh`. В качестве первого аргумента они принимают путь до папки с исходным кодом,
а последующие аргументы передаются в OCLint, позволяя изменять его поведение. Первый скрипт
предназначем для проектов, состоящих из одного файла с исходным кодом, а второй скрипт - для
проектов с использованием Makefile.
Папка `examples` содержит примеры для проверки работоспособности критериев. Примеры запускаются с помощью скриптов `test-gcc.sh` и `test-makefile.sh`. Больше информации по примерам в [Wiki (Примеры для проверки)](https://github.com/moevm/oclint_extensions/wiki/Примеры-для-проверки)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit c35c97c

Please sign in to comment.