Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AMPivovarov committed May 24, 2013
1 parent ac2dce6 commit acd31ac
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 49 deletions.
98 changes: 49 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
Compiler-Error-Assistant
========================
Скрипт-помощник разработчика, автоматизирующий поиск информации об ошибках компиляции на Stack Overflow и в Google.

FEATURES:
---------
* Представление списка ошибок
* Выдача ссылок на Stack Overflow по конкретной ошибке
* Открытие ссылки прямо из консоли
* Ссылка с поисковым запросом в Google (если не устраивают ссылки на Stack Overflow, или там ничего не найдено)

FILES:
------
* stwf.py - основной скрипт, принмающий stderr компилятора.
* wrapper.sh - вспомогательный скрипт для запуска основного скрипта из скриптов-оберток.
* sclang - скрипт-обертка для запуска clang
* sclang++ - скрипт-обертка для запуска clang++
* sg++ - скрипт-обертка для запуска g++
* sgcc - скрипт-обертка для запуска gcc

USAGE:
------
`./sg++ -- main.cpp`

Запустить компилятор g++ на файле main.cpp и перенаправить вывод stderr в stwf.py.

`./sg++ -- -Wall main.cpp`

Запустить компилятор g++ с указанными опциями.

`./sg++ -v -- main.cpp`

Передать опции основному скрипту.

`g++ -Wall main.cpp 2>&1 | ./stwf.py`

Перенаправить stderr компилятора в основной скрипт обычным образом.

stwf.py USAGE:
--------------
`stfw.py [-h] [-v] [-s] [-o OPEN_WITH]`

`-h, --help` показать справку и выйти

`-v, --verbose` показать полный вывод компилятора

`-s, --system-open` использовать браузер, установленный в системе по умлочанию

`-o OPEN_WITH, --open-with OPEN_WITH` использовать указанный браузер для открытия ссылок
Compiler-Error-Assistant
========================
Developer helper script that automates searching for information about compilation errors on Stack Overflow and Google.

FEATURES:
---------
* Presentation of the error list
* Issuance of references to Stack Overflow for the specific error
* Open a link directly from the console
* Link to the search query to Google (if you are not satisfied with references to Stack Overflow, or is there nothing found)

FILES:
------
* stwf.py - the main script, parses compiler messages.
* wrapper.sh - helper script to run the main script from wrapper scripts.
* sclang - wrapper script to run the clang
* sclang++ - scriptwrapper to run clang++
* sg++ - wrapper script to run g++
* sgcc - wrapper script to run the gcc

USAGE:
------
`./sg++ -- main.cpp`

Start the g++ compiler on the file main.cpp and redirect stderr output to the stwf.py.

`./sg++ -- -Wall main.cpp`

Start the g++ compiler with options.

`./sg++ -v -- main.cpp`

Option to the main script.

`g++ -Wall main.cpp 2>&1 | ./stwf.py`

Redirect stderr to the main script compiler normally.

stwf.py USAGE:
--------------
`stfw.py [-h] [-v] [-s] [-o OPEN_WITH]`

`-h, --help` show help and quit

`-v, --verbose` show the full output of the compiler

`-s, --system-open` use default browser

`-o OPEN_WITH, --open-with OPEN_WITH` use external programm to open links
49 changes: 49 additions & 0 deletions README_RUS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Compiler-Error-Assistant
========================
Скрипт-помощник разработчика, автоматизирующий поиск информации об ошибках компиляции на Stack Overflow и в Google.

FEATURES:
---------
* Представление списка ошибок
* Выдача ссылок на Stack Overflow по конкретной ошибке
* Открытие ссылки прямо из консоли
* Ссылка с поисковым запросом в Google (если не устраивают ссылки на Stack Overflow, или там ничего не найдено)

FILES:
------
* stwf.py - основной скрипт, принмающий stderr компилятора.
* wrapper.sh - вспомогательный скрипт для запуска основного скрипта из скриптов-оберток.
* sclang - скрипт-обертка для запуска clang
* sclang++ - скрипт-обертка для запуска clang++
* sg++ - скрипт-обертка для запуска g++
* sgcc - скрипт-обертка для запуска gcc

USAGE:
------
`./sg++ -- main.cpp`

Запустить компилятор g++ на файле main.cpp и перенаправить вывод stderr в stwf.py.

`./sg++ -- -Wall main.cpp`

Запустить компилятор g++ с указанными опциями.

`./sg++ -v -- main.cpp`

Передать опции основному скрипту.

`g++ -Wall main.cpp 2>&1 | ./stwf.py`

Перенаправить stderr компилятора в основной скрипт обычным образом.

stwf.py USAGE:
--------------
`stfw.py [-h] [-v] [-s] [-o OPEN_WITH]`

`-h, --help` показать справку и выйти

`-v, --verbose` показать полный вывод компилятора

`-s, --system-open` использовать браузер, установленный в системе по умлочанию

`-o OPEN_WITH, --open-with OPEN_WITH` использовать указанный браузер для открытия ссылок

0 comments on commit acd31ac

Please sign in to comment.