diff options
| author | ruki <[email protected]> | 2019-09-19 00:49:34 +0800 |
|---|---|---|
| committer | ruki <[email protected]> | 2019-09-18 22:57:25 +0800 |
| commit | bb3455b845e0b776937283b3ddae4ae557eea52e (patch) | |
| tree | 7625b08ec58620e048410017bfe18ff3fa536548 /xmake/scripts | |
| parent | 916078fdb2904340ef2003a46057d9232194511a (diff) | |
improve template
Diffstat (limited to 'xmake/scripts')
| -rw-r--r-- | xmake/scripts/faq.lua | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/xmake/scripts/faq.lua b/xmake/scripts/faq.lua new file mode 100644 index 000000000..602c89c34 --- /dev/null +++ b/xmake/scripts/faq.lua @@ -0,0 +1,68 @@ +-- +-- FAQ +-- +-- You can enter the project directory firstly before building project. +-- +-- $ cd projectdir +-- +-- 1. How to build project? +-- +-- $ xmake +-- +-- 2. How to configure project? +-- +-- $ xmake f -p [macosx|linux|iphoneos ..] -a [x86_64|i386|arm64 ..] -m [debug|release] +-- +-- 3. Where is the build output directory? +-- +-- The default output directory is `./build` and you can configure the output directory. +-- +-- $ xmake f -o outputdir +-- $ xmake +-- +-- 4. How to run and debug target after building project? +-- +-- $ xmake run [targetname] +-- $ xmake run -d [targetname] +-- +-- 5. How to install target to the system directory or other output directory? +-- +-- $ xmake install +-- $ xmake install -o installdir +-- +-- 6. Add some frequently-used compilation flags in xmake.lua +-- +-- @code +-- -- add debug and release modes +-- add_rules("mode.debug", "mode.release") +-- +-- -- add macro defination +-- add_defines("NDEBUG", "_GNU_SOURCE=1") +-- +-- -- set warning all as error +-- set_warnings("all", "error") +-- +-- -- set language: c99, c++11 +-- set_languages("c99", "c++11") +-- +-- -- set optimization: none, faster, fastest, smallest +-- set_optimize("fastest") +-- +-- -- add include search directories +-- add_includedirs("/usr/include", "/usr/local/include") +-- +-- -- add link libraries and search directories +-- add_links("tbox") +-- add_linkdirs("/usr/local/lib", "/usr/lib") +-- +-- -- add system link libraries +-- add_syslinks("z", "pthread") +-- +-- -- add compilation and link flags +-- add_cxflags("-stdnolib", "-fno-strict-aliasing") +-- add_ldflags("-L/usr/local/lib", "-lpthread", {force = true}) +-- +-- @endcode +-- +-- 7. If you want to known more usage about xmake, please see https://xmake.io +-- |