Skip to content

Updated and renamed README.txt to README.md #106198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 21, 2024
Merged

Conversation

tarik-celik
Copy link
Contributor

@tarik-celik tarik-celik commented Aug 27, 2024

No description provided.

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the clang Clang issues not falling into any other category label Aug 27, 2024
@llvmbot
Copy link
Member

llvmbot commented Aug 27, 2024

@llvm/pr-subscribers-clang

Author: Tarık Çelik (tarik-celik)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/106198.diff

2 Files Affected:

  • (added) clang/README.md (+25)
  • (removed) clang/README.txt (-26)
diff --git a/clang/README.md b/clang/README.md
new file mode 100644
index 00000000000000..b98182d8a3f684
--- /dev/null
+++ b/clang/README.md
@@ -0,0 +1,25 @@
+# C language Family Front-end
+
+Welcome to Clang. 
+
+This is a compiler front-end for the C family of languages (C, C++ and Objective-C) which is built as part of the LLVM compiler infrastructure project.
+
+Unlike many other compiler frontends, Clang is useful for a number of things beyond just compiling code: we intend for Clang to be host to a number of different           source-level tools. One example of this is the Clang Static Analyzer.
+
+If you're interested in more (including how to build Clang) it is best to read the relevant websites. Here are some pointers:
+
+* Information on Clang:      http://clang.llvm.org/
+
+* Building and using Clang:    http://clang.llvm.org/get_started.html
+
+* Clang Static Analyzer:    http://clang-analyzer.llvm.org/
+
+* Information on the LLVM project:    http://llvm.org/
+
+* If you have questions or comments about Clang, a great place to disucss them is on the Clang forums:    
+  
+  [Clang Frontend - LLVM Discussion Forums](https://discourse.llvm.org/c/clang/)
+
+* If you find a bug in Clang, please file it in the LLVM bug tracker:
+  
+    https://github.com/llvm/llvm-project/issues
diff --git a/clang/README.txt b/clang/README.txt
deleted file mode 100644
index 477f720b193fbd..00000000000000
--- a/clang/README.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-//===----------------------------------------------------------------------===//
-// C Language Family Front-end
-//===----------------------------------------------------------------------===//
-
-Welcome to Clang.  This is a compiler front-end for the C family of languages
-(C, C++, Objective-C, and Objective-C++) which is built as part of the LLVM
-compiler infrastructure project.
-
-Unlike many other compiler frontends, Clang is useful for a number of things
-beyond just compiling code: we intend for Clang to be host to a number of
-different source-level tools.  One example of this is the Clang Static Analyzer.
-
-If you're interested in more (including how to build Clang) it is best to read
-the relevant web sites.  Here are some pointers:
-
-Information on Clang:             http://clang.llvm.org/
-Building and using Clang:         http://clang.llvm.org/get_started.html
-Clang Static Analyzer:            http://clang-analyzer.llvm.org/
-Information on the LLVM project:  http://llvm.org/
-
-If you have questions or comments about Clang, a great place to discuss them is
-on the Clang forums:
-  https://discourse.llvm.org/c/clang/
-
-If you find a bug in Clang, please file it in the LLVM bug tracker:
-  https://github.com/llvm/llvm-project/issues

Copy link
Contributor

@cor3ntin cor3ntin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess git is too confused to see through the rename. Oh well.
Changes LGTM anyway

Copy link

⚠️ We detected that you are using a GitHub private e-mail address to contribute to the repo.
Please turn off Keep my email addresses private setting in your account.
See LLVM Discourse for more information.

@tarik-celik
Copy link
Contributor Author

Ping

@tarik-celik tarik-celik requested a review from cor3ntin September 8, 2024 21:29
@cor3ntin cor3ntin merged commit f5f61c8 into llvm:main Sep 21, 2024
5 of 7 checks passed
Copy link

@tarik-celik Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants