Commit Graph

137 Commits

Author SHA1 Message Date
Petr Zemek
18ab21ee6e Mention the vim-syntax-retdecdsm repository in README.
It provides a Vim syntax-highlighting file for the output from the RetDec's
disassembler (.dsm files).
2017-12-18 07:44:44 +01:00
Petr Zemek
e8498d73c4 Add link to the list of RetDec related publications into README. 2017-12-17 10:33:01 +01:00
Petr Zemek
75eec65e5e Improve the note about the required C++ compiler in README.
RetDec needs both a C++14 capable compiler as well as a proper implementation
of the standard C++ library.
2017-12-17 10:00:19 +01:00
Petr Zemek
05b34d8932 Add a link to our Botconf 2017 talk to README. 2017-12-17 09:56:26 +01:00
Marek Milkovič
08810d3333 Updated fileformat and fnc-patterns submodules 2017-12-17 00:41:15 +01:00
Petr Zemek
d71545f6eb Mention removal of duplicate lib prefixes from libdwarf and libelf in CHANGELOG (#31). 2017-12-15 18:39:18 +01:00
Peter Matula
d55a05c3bd update submodules 2017-12-15 16:33:20 +01:00
Peter Matula
0254b12598 Merge branch 'issue-12' 2017-12-15 13:58:00 +01:00
Peter Matula
1fd9d34ed5 install documentation into <install_dir>/share/retdec/doc
instead of <install_dir>/doc
2017-12-15 13:57:32 +01:00
Peter Matula
fb9b340480 install retdec support to <install_dir>/share/retdec/support
this should solve #12. script no longer clears (rm -rf)
<install_dir>/share, it clears <install_dir>/share/retdec/support.
2017-12-15 13:56:37 +01:00
Viktor Oreshkin
e2fa7df4fb Add macOS info to README 2017-12-15 13:55:21 +03:00
Viktor Oreshkin
55c2d04202 Fix bin2llvmirtool/llvmir2hlltool macOS build 2017-12-15 13:50:20 +03:00
Petr Zemek
8ec047f591 Specify the language for all code blocks in README.
This ensures that the code is highlighted properly when rendered on GitHub.
2017-12-15 11:12:55 +01:00
Petr Zemek
efda4a22a2 Mention that RetDec build optionally requires Doxygen and Graphviz in README. 2017-12-15 11:10:47 +01:00
Petr Zemek
a82bf36ef0 Fix the used Python version in the apt-get command in README.
RetDec requires Python 3, which is installed by `python3`, not `python`.
2017-12-15 11:02:45 +01:00
Petr Zemek
ce42bdcc78 Add a warning that decompilations of large binaries may require a lot of RAM into README (#36). 2017-12-15 10:56:31 +01:00
Marek Milkovič
c2b4ba45b5 Added dnf install command into README 2017-12-15 09:30:54 +01:00
Petr Zemek
b950114c1a Unify title casing in README. 2017-12-15 06:07:57 +01:00
Petr Zemek
8bc6e5518f Add a missing requirement for Linux builds into README: libtool. 2017-12-14 16:05:42 +01:00
Petr Zemek
e361fac3c9 Mention that we support only Windows 7 or later.
The reason is that LLVM supports only Windows 7 or later [1]:

    "Since LLVM 3.8, the minimum Windows version required for running LLVM is
    Windows 7. Earlier versions, including Windows Vista and XP are no longer
    supported."

[1] http://releases.llvm.org/3.8.0/docs/ReleaseNotes.html#non-comprehensive-list-of-changes-in-this-release
2017-12-14 15:02:24 +01:00
Petr Zemek
7aa5a8cb0e Add more Linux build requirements into README. 2017-12-14 15:02:01 +01:00
Petr Zemek
c2e98601fc Update build requirements in README. 2017-12-14 10:42:26 +01:00
Petr Zemek
77845552a2
Merge pull request #22 from Manouchehri/README-apt
Added apt-get packages
2017-12-14 10:11:08 +01:00
David Manouchehri
877ded1902
Added apt-get command. 2017-12-13 20:26:13 -05:00
Petr Zemek
4409bed3f5 Improve the wording of the warning in README concerning system-wide installations.
The original warning is from commit c1206a65cf.
2017-12-13 19:14:16 +01:00
Petr Zemek
03ea29a27f When installing the decompiler, do not remove the entire share directory (#12).
Remove only the subdirectories and files that are used by RetDec. This should
reduce the chance of unintentionally removing system directories when RetDec is
accidentally installed on Linux into e.g. `/usr` as the `arm`, `generic`, and
`x86` directories are not commonly used by Linux distributions.

Nevertheless, as mentioned in our README, until our build system properly
supports system-wide installations, RetDec should to be installed into a clean,
dedicated directory.
2017-12-13 19:08:53 +01:00
Peter Matula
c1206a65cf readme: add warning about installation. 2017-12-13 16:18:07 +01:00
Petr Zemek
bfe50921f1 Unify spaces vs tabs in scripts.
We generally use tabs in scripts, so be consistent.
2017-12-13 14:11:23 +01:00
Petr Zemek
6fef1f21eb Fix the position of ';;' in a case statement in install-share.sh.
We should put it on the same level as the statement.
2017-12-13 14:02:39 +01:00
Petr Zemek
e6491fccc9 Improve OS type detection when running install-share.sh during make install.
We need to also include e.g. "WindowsNT" and "CYGWIN_NT".
2017-12-13 14:00:49 +01:00
Petr Zemek
b19112dc8d Remove useless OS type detection from config.sh (#10).
The OS type detection is no longer used anywhere, so we can remove it.
2017-12-13 11:52:59 +01:00
Petr Zemek
a75a44fd18 Add CHANGELOG. 2017-12-13 07:21:04 +01:00
Petr Zemek
c42dfb144b Add links to pre-built Windows packages into README (v3.0). 2017-12-13 06:41:36 +01:00
Petr Zemek
b1ede30a92 Mention that Windows users need to install MSVC 2015 redistributable in README. 2017-12-12 19:09:50 +01:00
Petr Zemek
fb6e196fa5 Improve build, installation, and use in README. 2017-12-12 19:03:40 +01:00
Petr Zemek
4369806223 Fix the heading in README.
The first heading should be h1, not h2.
2017-12-12 18:20:08 +01:00
Petr Zemek
d9230cbc94 Initial commit. 2017-12-12 18:05:30 +01:00