From 24cd4a17dfcc192251e6f1c1d3ef7c555d26527c Mon Sep 17 00:00:00 2001 From: William Lee Date: Tue, 25 Jun 2024 19:59:13 +0800 Subject: [PATCH] (MOD) Refined README --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e0814fb..1422d27 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,9 @@ Generally, Compound is a library for general-purposes programming which you will It is worth noticing that, this library is completely aimed for creating another language. That means, every feature update is supposedly to serve the language. --- -## BUILDING - -To build Compound, all you need is to type as follow in a terminal: +## Building ```shell -cmake . # Generate "Makefile" -make # Build +cmake . && make ``` > *PLEASE NOTICE* @@ -35,12 +32,25 @@ Compound, now, roughly divides platform compatibilities into 2 major parts, the This idea is ready for refinements, you can put up such suggestions and they're welcomed. ## Installation -To install Compound, all you need to do is to run `install`, something like below. ```shell -./install # (Require root privilege) +./preinstall # (Require root privilege) +./postinstall # (Require root privilege) ``` -If you cannot execute ./install script, try to add permission for execution: +> *I TELL YOU WHAT* +> *It is for the convenience of project building automation that the installation procedure being devided into two different parts.* +> *In general, the "preinstall" copies the header files into system "include" directory,* +> *while the "postinstall" copies the compiled library into system library directory.* + + +And if you cannot execute the scripts, try to add permission for execution: ```shell -chmod +x ./install # (Require root privilege) +chmod +x ./the_file_lacks_of_permission_to_execute_and_to_be_honest_i_dont_know_why_do_i_have_to_put_the_name_so_long_that_none_of_you_would_like_to_read_it_through_but_since_you_have_gotten_this_far_congrats_you_are_my_big_star_now_oh_by_the_way_do_you_know_that_the_cat_of_mine_can_actually_talk_cause_last_sunday_when_i_head_to_kitchen_for_some_drinks_and_i_heard_something_mumbling_behind_the_door_and_i_went_up_to_check_what_it_was_and_it_turns_out_that_it_was_my_cat_speaking_and_what_it_said_was_meow ``` + +## Troubleshoot +For now, we wish more of you to put up issues so that the problems can be spotted. + +> *NOT SO FAST* +> *If you got a problem, try to look up for similar or same issues that had been put up already, * +> *'cause you don't want to have your reply simply written something like "ah yeah yeah, we've been through that sometime earlier".*