Commit Graph

38 Commits

Author SHA1 Message Date
Lucas Schwiderski f3a0937ea3
Remove advanced building options from README
This removes the section about advanced build options and build
dependencies and points to the docs page instead.

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-23 10:18:33 +01:00
Lucas Schwiderski cce8e80cbd
Improve code snippet rendering in README
This converts the code snippets to the alternate block definition and
adds language hints to enable syntax highlighting for compatible parsers
(such as on the GitHub page).

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
2021-03-23 10:18:32 +01:00
actionless 68651477fb refactor(test: awesomerc: hotkeys): imitate fake vim client instead of depending on vim as test dep 2019-10-18 19:02:47 +02:00
actionless e048c4200c style(readme): remove dots at the end of the list items 2019-10-18 18:52:44 +02:00
actionless 0333cddfa2 doc(readme): add xterm to test deps 2019-10-18 18:50:43 +02:00
actionless e78d711846 doc(readme): add vim to test deps 2019-10-18 18:45:18 +02:00
Xinhao Yuan 0e8dd4c1c9 Added more tests to check partial maximization handling, which require wmctrl as an optional dependency. 2019-10-17 18:54:29 -04:00
Uli Schlachter 6101ef5186 Add libRSVG to the list of optional dependencies (#2837)
Since commit 3295e9f33d, the imagebox tries to use libRSVG via
lgi.Rsvg to load SVG files without rasterising them immediately.
Instead, they are directly drawn at the expected size.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-07-28 17:23:44 -04:00
mergify[bot] 9865f4592b
Merge pull request #2787 from alfunx/readme-fixes
Fix minor stuff in README
2019-06-10 12:07:05 +00:00
DrEuler 184de0ab82 Update 01-readme.md (#2786)
Fixed a spelling error
2019-06-09 16:11:11 -04:00
Alphonse Mariya a64e82d43e
Fix minor stuff in README 2019-06-09 19:47:31 +02:00
Uli Schlachter a57c79687a Use xcb-errors library if it is available
This library allows to get a human-readable string describing X11
requests, events, and errors. We now use this library to pretty-print
X11 errors if we get any.

To test this code, I added the following two lines to AwesomeWM so that
X11 errors are generated:

    xcb_set_input_focus(globalconf.connection, 42, 42, 42);
    xcb_randr_set_output_primary(globalconf.connection,
        globalconf.screen->root, 42);

Output without xcb-errors:

    X error: request=SetInputFocus (major 42, minor 0), error=BadValue (2)
    X error: request=(null) (major 140, minor 30), error=(null) (147)

Output with xcb-errors:

    X error: request=SetInputFocus (major 42, minor 0), error=Value (2)
    X error: request=RandR-SetOutputPrimary (major 140, minor 30), error=RandR-BadOutput (147)

Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-03-03 09:15:29 +01:00
Uli Schlachter 2023ed187a Add xcb-xfixes as a new dependency and initialise it
This commit prepares changes in the following commits

Signed-off-by: Uli Schlachter <psychon@znc.in>
2019-02-06 09:21:26 +01:00
Emmanuel Lepage Vallée 0a999c4192 Change the badge URL from travis-ci.org to travis-ci.com (#2625) 2019-01-29 11:24:31 +01:00
actionless d121780366 doc(readme): add receipts for installing current git master 2019-01-01 18:43:43 +01:00
actionless 29b2b7138d doc(readme): add section about IRC 2018-11-19 22:09:46 +01:00
actionless 86084690b2 doc(readme): add questions section; split issues and contributing; fix apidoc link (in ldoc) 2018-11-19 22:01:37 +01:00
Yauhen Kirylau 4bd5b1940d feat(themes; beautiful): add partial support for GTK+3 themes (#2129) 2018-06-26 10:43:20 -04:00
Joseph Herlant d9cc56538f build: man pages: use asciidoctor instead of asciidoc (#2234) 2018-04-04 11:28:50 +02:00
Uli Schlachter 43e268373d Mention minimum ldoc version in the readme (#2027)
See commit 2c741f8e1d which introduced this dependency.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-09-09 05:14:41 +02:00
Luke Bonham 4fc3108e0f Fix doc typos and optimised PNGs (#2000) 2017-08-16 20:07:08 +02:00
Uli Schlachter 84080c64c5 spawn: Use CLOEXEC for pipes (#1811)
Fixes: https://github.com/awesomeWM/awesome/issues/1193#issuecomment-305705724
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-06-02 10:13:26 +02:00
Uli Schlachter 0707f52ebf Get rid of broken hint in the readme (#1801)
luaL_dostring(L, s) is a macro that expands to
luaL_loadstring(L,s)||lua_pcall(L,0,LUA_MULTRET,0). Then,
lua_pcall(L,n,r,f) sometimes (since Lua 5.3?) is a macro that expands to
lua_pcallk(L,n,r,f,0,NULL), but can sometimes also just be a function.

Explaining all the above would make this section more complicated and
apparently no one uses this hint anyway, because no one told us yet that
this hint does not work.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-05-30 10:28:44 +02:00
Emmanuel Lepage Vallee 528ab6c7cf doc: Removed remaining references to .lua.in files
The .in is no longer used

Fix #1525
2017-02-05 12:16:27 -05:00
Uli Schlachter 1078a9f395 Bump minimal LGI version to 0.8.0 (#1350)
Turns out that menubar already uses features that were only added in
that version.

Fixes: https://github.com/awesomeWM/awesome/issues/1348
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-01-02 19:53:02 +01:00
Mikko Valkonen 397fb2eb7f doc: add instructions to pass args to cmake (#1317)
Adds a small note to the README for passing arguments to cmake during
the build by using the `CMAKE_ARGS` environment variable
2016-12-28 12:39:03 +01:00
Emmanuel Lepage Vallée 8935ed2a30 Remove traces of the old URL (#1280)
**WARNING**: This breaks the API
2016-12-21 02:03:03 +01:00
Yauhen Kirylau 4efdd2f5c6 docs(readme): add xcb-util-xrm to dependencies' list 2016-11-14 13:31:59 +01:00
Uli Schlachter 0363b3a72b Add a list of build dependencies to the readme (#1087)
Fixes: https://github.com/awesomeWM/awesome/issues/426
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-09-12 23:46:47 +02:00
Daniel Hahler aae81b7e2a docs: add section about gdb to readme
This should maybe get added to a separate section/page altogether

instead, but in this short form it seems to fit here.
2016-04-04 22:44:49 +02:00
Daniel Hahler e19f73c6bf Merge pull request #79 from akdor1154/versioningFix
Implement basic DEB/RPM packaging
2016-03-15 00:23:51 +01:00
Daniel Hahler 19d0cbdb65 README: link to contributing guide on master
Fixes https://github.com/awesomeWM/awesome/issues/739.
Closes https://github.com/awesomeWM/awesome/pull/750.
Closes https://github.com/awesomeWM/awesome/pull/752.
2016-03-09 00:12:53 +01:00
Daniel Hahler a256c9676b doc: link to automatically built docs for master
[ci skip]
2016-03-03 22:06:23 +01:00
Jarrad Whitaker 0283bab54f implement basic DEB packaging 2016-02-28 20:07:54 +11:00
Daniel Hahler 3fb83ba9b5 README: add reference to online doc, small improvements
Closes https://github.com/awesomeWM/awesome/pull/345.
2015-07-25 15:12:48 +02:00
Daniel Hahler 9b9334976a Add config for Travis CI
This builds and installs awesome (which runs its checks) and displays
--version.

 - Build libxcb-cursor-dev and lua-lgi manually.
 - A lot of dependencies are installed manually from Git or luarocks.
 - Include Travis status in README.

Closes https://github.com/awesomeWM/awesome/pull/208.
2015-04-26 04:01:32 +02:00
Julian Wollrath 4d76967397 Beautify docs a little bit.
Signed-off-by: Julian Wollrath <jwollrath@web.de>
2015-02-28 23:14:13 +01:00
Ignas Anikevicius (gns_ank) b96b3ef31c Docs: Move all docs to a `docs` folder.
This moves all of the documentation into a separate folder, which keeps
everything in one place and avoids unnecessary clutter.

This will pay off when proper guides are written for various aspects of
using awesome or contributing to it.

This also updates the building system, so that the docs are properly
generated with new directories.

Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:12 +01:00