diff options
author | Alexis Hildebrandt <afh@surryhill.net> | 2023-04-13 00:09:00 +0200 |
---|---|---|
committer | Alexis Hildebrandt <afh@surryhill.net> | 2023-04-13 00:09:00 +0200 |
commit | dffd6dfadcda16284baf661811f93ef4f99bdacb (patch) | |
tree | 56be8288b523de8e31f0bedb7425a2c800fa6ab6 | |
parent | 8cdd6101814bde61ab4ce772e04eccf829275080 (diff) | |
download | fork-ledger-dffd6dfadcda16284baf661811f93ef4f99bdacb.tar.gz fork-ledger-dffd6dfadcda16284baf661811f93ef4f99bdacb.tar.bz2 fork-ledger-dffd6dfadcda16284baf661811f93ef4f99bdacb.zip |
Some README and INSTALL clean-up
-rw-r--r-- | INSTALL.md | 27 | ||||
-rw-r--r-- | README.md | 19 |
2 files changed, 24 insertions, 22 deletions
@@ -5,7 +5,7 @@ To build this code after doing a Git clone, run: $ ./acprep dependencies $ ./acprep update -If anything goes wrong, see "COMMON CONFIGURE/BUILD PROBLEMS" below. +If anything goes wrong, see [COMMON CONFIGURE/BUILD PROBLEMS](#common-configure--build-problems) If you try to configure and build without running acprep first, you are almost certainly going to run into problems. In future, you can run @@ -97,10 +97,11 @@ A: Actually, the real segfault is in libstdc++'s facet code. It's being Q: Something else fails, or Ledger crashes on startup -A: This, I am most interested in hearing about. Please file a bug at the - Ledger Issue Tracker, https://github.com/ledger/ledger/issues. The more +A: This, I am most interested in hearing about. Please + [file a bug report](https://bugs.ledger-cli.org/new) at the + [Ledger Issue Tracker](https://bugs.ledger-cli.org). The more details you can provide, the better. Also, if Ledger is crashing, try - running it under gdb like so: + running it under a debugger, e.g. gdb or lldb, like so: $ gdb ledger (gdb) run <ARGS TO LEDGER> @@ -139,16 +140,16 @@ Q: My distribution has versions of Boost and/or CMake that are too old for work properly with Ledger? Thereafter, how do I configure Ledger properly to use those newly built versions of Boost and/or CMake? -A: Here's commands that one user used to make this work, for Boost 1.51.0 - on Debian GNU/Linux 6.0.x (aka Debian squeeze). It's likely to work ok - for other versions of Boost as well. YMMV on other distributions and/or - other Debian distribution versions, though. +A: Here's commands that one user used to make this work, for Boost 1.72.0 + on Debian GNU/Linux 11 (aka Debian bullseye). It's likely to work ok + for other versions of Boost as well. [YMMV] on other distributions and/or + other Debian versions, though. - Preparing and building Boost - $ export BOOST_VERSION=1.57.0 + $ export BOOST_VERSION=1.72.0 $ cd /somewhere/you/want/to/build/boost - $ wget -N http://iweb.dl.sourceforge.net/project/boost/boost/$BOOST_VERSION/boost_${BOOST_VERSION//./_}.tar.bz2 + $ wget -N https://boostorg.jfrog.io/artifactory/main/release/$BOOST_VERSION/source/boost_${BOOST_VERSION//./_}.tar.gz $ tar xvf boost_${BOOST_VERSION//./_}.tar.bz2 $ cd boost_${BOOST_VERSION//./_} $ ./bootstrap.sh @@ -157,9 +158,9 @@ A: Here's commands that one user used to make this work, for Boost 1.51.0 - Preparing and building CMake - $ export CMAKE_VERSION=3.1.0 + $ export CMAKE_VERSION=3.16.2 $ cd /somewhere/you/want/to/build/cmake - $ wget -N http://www.cmake.org/files/v${CMAKE_VERSION:0:3}/cmake-${CMAKE_VERSION}.tar.gz + $ wget -N https://cmake.org/files/v${CMAKE_VERSION:0:-2}/cmake-${CMAKE_VERSION}.tar.gz $ tar xvf cmake-${CMAKE_VERSION}.tar.gz $ cd cmake-${CMAKE_VERSION} $ ./configure --prefix=/where/you/want/cmake/installed/ @@ -173,3 +174,5 @@ A: Here's commands that one user used to make this work, for Boost 1.51.0 $ ./acprep --prefix=$PREFIX --debug --python config $ ./acprep --prefix=$PREFIX --debug --python make $ ./acprep --prefix=$PREFIX --debug --python install + +[YMMV]: https://www.acronymfinder.com/Your-Mileage-May-Vary-(YMMV).html @@ -32,9 +32,9 @@ Now try your first ledger command: $ ./ledger -f test/input/sample.dat reg -For help on keeping your journal have a look at the -[documentation] and the [wiki][] (Also see the “Resources” section at the -end of this file). An Emacs mode for Ledger files can be found in the +For help on keeping your journal have a look at the [documentation], the [wiki], +and the [Resources](#resources) section at the end of this file. +An Emacs mode for Ledger files can be found in the [ledger/ledger-mode repository] and a vim plugin is located in the [ledger/vim-ledger repository]. @@ -46,14 +46,12 @@ If you have Docker installed on your computer or server, you can use a [Docker v ## Dependencies -If you wish to proceed in this venture, you'll need a few dependencies. The -easiest way to get them for your platform is to run this handy Python -script: +If you wish to proceed in this venture, you'll need a few dependencies. +Note that some features, e.g. `--import` require building Ledger with Python support. +The easiest way to get them for your platform is to run this handy Python script: $ ./acprep dependencies -Note that some features, e.g. `--import` require building Ledger with -Python support. If that doesn't completely work, here are the dependencies for building the current `master` branch: @@ -172,9 +170,9 @@ Now that you're up and running, here are a few resources to keep in mind: - [Code analysis][openhub] If you have ideas you'd like to share, the best way is either to e-mail me a -patch (I prefer attachments over pasted text), or to get an account on GitHub. +patch (I prefer attachments over pasted text), or to [get an account on GitHub](https://github.com/signup). Once you do, fork the [Ledger project][github], -hack as much as you like, then send me a pull request via GitHub. +hack as much as you like, then [open a pull request on GitHub](https://github.com/ledger/ledger/pulls). [Homepage]: https://ledger-cli.org/ [documentation]: https://www.ledger-cli.org/docs.html @@ -183,6 +181,7 @@ hack as much as you like, then send me a pull request via GitHub. [IRC]: irc://irc.libera.chat/ledger [github]: https://github.com/ledger/ledger [ledger/vim-ledger repository]: https://github.com/ledger/vim-ledger +[ledger/ledger-mode repository]: https://github.com/ledger/ledger-mode [Homebrew]: https://brew.sh/ [MacPorts]: https://www.macports.org/ [CMake]: https://cmake.org |